Event Notification API

2.0.x
(0 reviews)

Event Notification Important Information

Event Notification APIs
Important Information & Bank of Ireland’s API Implementation

This page is a reflection of Bank of Ireland’s implementation of the Open Banking Event Notifications APIs.

Events Produced from Access Dashboards:

When B365/BOL customer revokes the access from the TPPs for given consents from ASPSP Access Dashboards that results in events being produced.

Currently AISP and CBPII for BOI UK and BOI ROI along with PISP VRP for sweeping for BOI UK events are in scope.

Supported APIs:

Bank of Ireland supports below APIs:

  • Event Notification Subscription API.
  • Aggregated Polling API

Bank of Ireland does not support the below APIs:

  • Callback URL API.
  • Real Time Event Notification API

1 Event-Notification-Subscription-APIs:

Supported Endpoints:

1 . Bank of Ireland supports below subscription endpoints:

  • POST /event-subscriptions
  • GET /event-subscriptions
  • DELETE /event-subscriptions/{EventSubscriptionId}

2 . Bank of Ireland does not support below endpoint:

  • PUT /event-subscriptions/{EventSubscriptionId}

Supported Fields for Event Subscription:

  1. Bank of Ireland only supports one event type ‘UK.OBIE.Consent-Authorization-Revoked’. Request with any other event type will be declined.
  2. Bank of Ireland does not support the ‘CallbackUrl’ field as Real-time notification API is not supported. Request with this parameter wil be declined.

Bank of Ireland will maintain at most, a single event-subscription resource per TPP at any point in time.

2. Aggregated Polling API - POST/Events:

Supported Fields:

1. maxEvents:

  • Using this parameter a TPP can request the maximum number of events to be returned in polling. For requests with value greater than 10, BOI will accept the request but will return a maximum of 10 events in a single API response with moreAvailable flag as ‘True’ if more awaited events are available.
  • TPPs can poll again subsequently to receive remaining events.
  • If no further events are available the moreAvailable flag will be set to ‘False’ in response to TPP.

2. returnImmediately:

  • BOI only supports short polling therefore only ‘True’ value is supported,
  • BOI does not support long polling so request with value as ‘False’ will be declined.

3. ack:

  • Bank of Ireland does not expect acknowledgments/negative acknowledgments of events from TPPs.
  • If passed in request, BOI accepts the request but does not process the acknowledgments.
  • Once the events are delivered to the TPPs they are deleted from the queues and cannot be re delivered irrespective of Ack/Nack.

Polling Interval:

BOI does not enforce any polling interval between two consecutive calls for a TPP, however if there are no awaited events available meaning moreAvailable

flag is set to ‘False’, we recommend the TPPs to retry after an hour.

Event Recycling Frequency:

BOI does not recycle and reuse the JWT Identifiers.

BOI can only retain the awaited events for a maximum of 14 days after which they are deleted from the queues even if not polled by TPPs.

Reviews